Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Updating profiler tutorial to include new custom operator profiling #15403

Merged
merged 14 commits into from
Jul 3, 2019
Merged

Conversation

Zha0q1
Copy link
Contributor

@Zha0q1 Zha0q1 commented Jun 28, 2019

Description

This PR updates the profiler tutorial to include a new section on profiling custom operators.
This is a reflection on my work here: #15210

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

  • Feature1, tests, (and when applicable, API doc)
  • Feature2, tests, (and when applicable, API doc)

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here

@Zha0q1 Zha0q1 requested a review from szha as a code owner June 28, 2019 21:05
@sandeep-krishnamurthy
Copy link
Contributor

@aaronmarkham - Can you please help review. Thanks.

@aaronmarkham aaronmarkham added pr-awaiting-review PR is waiting for code review Doc labels Jun 28, 2019
Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some spelling and rephrasing...

docs/tutorials/python/profiler.md Outdated Show resolved Hide resolved
docs/tutorials/python/profiler.md Outdated Show resolved Hide resolved
docs/tutorials/python/profiler.md Outdated Show resolved Hide resolved
@Zha0q1
Copy link
Contributor Author

Zha0q1 commented Jun 28, 2019

Some spelling and rephrasing...

Thanks! I have committed all the suggested changes.

Copy link
Contributor

@sandeep-krishnamurthy sandeep-krishnamurthy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. Few comments.

docs/tutorials/python/profiler.md Outdated Show resolved Hide resolved
docs/tutorials/python/profiler.md Outdated Show resolved Hide resolved
docs/tutorials/python/profiler.md Outdated Show resolved Hide resolved
docs/tutorials/python/profiler.md Outdated Show resolved Hide resolved
docs/tutorials/python/profiler.md Outdated Show resolved Hide resolved
docs/tutorials/python/profiler.md Outdated Show resolved Hide resolved
@Zha0q1
Copy link
Contributor Author

Zha0q1 commented Jul 2, 2019

#15403 (comment)

OK, I can add another code snippet and make sure we have this line:
profiler.set_config(profile_symbolic = False, aggregate_stats = True, profile_imperative = False)

@sandeep-krishnamurthy sandeep-krishnamurthy merged commit d49445f into apache:master Jul 3, 2019
access2rohit pushed a commit to access2rohit/incubator-mxnet that referenced this pull request Sep 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Doc pr-awaiting-review PR is waiting for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants